diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..53614bae56939968f17cbc5cb032e4f551267c5e --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +This project provides useful Python tools for executing TraceWin, and reading/writing TraceWin data files. + +The files are written primarily for usage at European Spallation Source, but might be useful elsewhere. + +You are free to use this code, but no warranty whatsoever is given. + +Installation +------------ + +To install the package, first download from GitLab. Then enter the directory, and run the setup script. An example is shown below of these three steps, where the installation is for the user only instead of system wide. + +```bash +git clone https://gitlab01.esss.lu.se/ess-bp/ess-python-tools.git +cd ess-python-tools +python setup.py install --user +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index 0b302048d97492299264872eee932f28a177fcbb..0000000000000000000000000000000000000000 --- a/README.rst +++ /dev/null @@ -1,15 +0,0 @@ -This project provides useful Python tools for executing TraceWin, and reading/writing TraceWin data files. - -The files are written primarily for usage at European Spallation Source, but might be useful elsewhere. - -You are free to use this code, but no warranty whatsoever is given. - -## Installation ## - -To install the package, first download from Bitbucket. Then enter the directory, and run the setup script. An example is shown below of these three steps, where the installation is for the user only instead of system wide - - git clone https://bitbucket.org/ess-bp/ess-python-tools.git - - cd ess-python-tools - - python setup.py install --user