You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,7 @@ Upon migrating the code base to GitHub and publishing distributions on PyPI in A
59
59
60
60
### Profile directories
61
61
62
-
The _labscript suite_ profile directory, containing application configurations, logs, and user-side code, is now located by default in the current user’s home directory, e.g. for a local user named `wkheisenberg` this is:
62
+
The _labscript suite_ profile directory, containing application configurations, logs, and user-side code, is now located by default in the current user's home directory, e.g. for a local user named `wkheisenberg` this is:
63
63
64
64
*`C:\Users\wkheisenberg\labscript-suite` on Windows.
65
65
*`~/labscript-suite` or `/home/wkheisenberg/labscript-suite` on Linux and Mac OS X.
@@ -190,13 +190,13 @@ We are very grateful for all the contributions users have made in the past decad
190
190
191
191
The issue tracking on GitHub is very similar to BitBucket, with the added advantage that you can add inter-repository issue references, e.g. referring to [labscript-suite/runmanager#68](https://github.com/labscript-suite/runmanager/issues/68) in any issue or pull request will link to the corresponding issue. We have imported all issues from the BitBucket repositories into the GitHub repositories. This import is not perfect (as each comment is now posted by Phil Starkey) but the comments have been modified to contain the original author attribution. We have also updated all links to files, pull requests, issues, and commits so that they point to the equivalent GitHub location and/or the archived copy of the data (as discussed above).
192
192
193
-
Please use the GitHub issue tracker (rather than the mailing list) for:
193
+
Please use the issue tracker of the relevant GitHub repository for:
194
194
195
-
* Reporting **bugs** (when something doesn’t work or works ina way you didn’t expect);
195
+
* Reporting **bugs** (when something doesn't work or works in a way you didn't expect);
196
196
* Suggesting **enhancements**: new features or requests;
197
197
* Issues relating to **installation**, **performance**, or **documentation**.
198
198
199
-
However, advice for how to do something with the existing functionality of the _labscript suite_ is better suited to the mailing list.
199
+
For advice on _how_ to use the existing functionality of the _labscript suite_, please use our [mailing list](http://groups.google.com/group/labscriptsuite).
Copy file name to clipboardExpand all lines: docs/source/archive.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## BitBucket archive
2
2
3
-
Some repository metadata (such as pull request discussions) could not be migrated directly from BitBucket to GitHub. As such, we have created an archived copy of everything that was on BitBucket. This includes:
3
+
In April–May 2020 the _labscript suite_ code base was migrated from BitBucket to GitHub. All commit history and issues was preserved, however some repository metadata (such as pull request discussions) could not be migrated directly. As such, we have created an archived copy of everything that was on BitBucket. This includes:
Copy file name to clipboardExpand all lines: docs/source/contributing.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ We are very grateful for all the contributions users have made in the past decad
7
7
8
8
The issue tracking on GitHub is very similar to BitBucket, with the added advantage that you can add inter-repository issue references, e.g. referring to [labscript-suite/runmanager#68](https://github.com/labscript-suite/runmanager/issues/68) in any issue or pull request will link to the corresponding issue. We have imported all issues from the BitBucket repositories into the GitHub repositories. This import is not perfect (as each comment is now posted by Phil Starkey) but the comments have been modified to contain the original author attribution. We have also updated all links to files, pull requests, issues, and commits so that they point to the equivalent GitHub location and/or the archived copy of the data (as discussed above).
9
9
10
-
Please use the GitHub issue tracker (rather than the mailing list) for:
10
+
Please use the issue tracker of the relevant GitHub repository for:
11
11
12
-
* Reporting **bugs** (when something doesn’t work or works ina way you didn’t expect);
12
+
* Reporting **bugs** (when something doesn't work or works in a way you didn't expect);
13
13
* Suggesting **enhancements**: new features or requests;
14
14
* Issues relating to **installation**, **performance**, or **documentation**.
15
15
16
-
However, advice for how to do something with the existing functionality of the _labscript suite_ is better suited to the mailing list.
16
+
For advice on _how_ to use the existing functionality of the _labscript suite_, please use our [mailing list](http://groups.google.com/group/labscriptsuite).
17
17
18
18
19
19
### Request for developers
@@ -46,7 +46,7 @@ You can learn more about this branching model at:
46
46
47
47
### Learning Git
48
48
49
-
As our former development, installation, and upgrading practices involved Mercurial revision-control, some of you may not be familiar with Git. While you no longer need to use _any_ revision control system to use the _labscript suite_, those of you wanting to contribute to development who aren’t acquainted with Git may benefit from these resources:
49
+
As our former development, installation, and upgrading practices involved Mercurial revision-control, some of you may not be familiar with Git. While you no longer need to use _any_ revision control system to use the _labscript suite_, those of you wanting to contribute to development who aren't acquainted with Git may benefit from these resources:
50
50
51
51
* NumPy: [Getting started with Git development](https://numpy.org/doc/stable/dev/gitwash/development_setup.html)
52
52
*[GitHub Guides](https://guides.github.com/): Very cogent information for beginners. We recommend starting with:
Copy file name to clipboardExpand all lines: docs/source/installation.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ This makes it far easier to get started using the _labscript suite_, as you no l
10
10
11
11
### Virtual environments
12
12
13
-
We recommend installing labscript (regular or developer mode) in a [virtual environment](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments). This helps sandbox the codebase without interfering with (or being interfered with) your system Python installation, or Python environments used for other purposes. There are a number of ways to configure a virtual environment. If you are unfamiliar with doing so, we recommend using the [venv module](https://docs.python.org/3/library/venv.html), part of the Python Standard Library. Here’s an example (on Windows):
13
+
We recommend installing labscript (regular or developer mode) in a [virtual environment](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments). This helps sandbox the codebase without interfering with (or being interfered with) your system Python installation, or Python environments used for other purposes. There are a number of ways to configure a virtual environment. If you are unfamiliar with doing so, we recommend using the [venv module](https://docs.python.org/3/library/venv.html), part of the Python Standard Library. Here's an example (on Windows):
14
14
15
15
16
16
#### Quick start
@@ -46,7 +46,7 @@ Once activated, the name of the virtual environment (in this case, `.venv`) will
46
46
C:\labscript-suite> .venv\Scripts\activate
47
47
```
48
48
49
-
_Note:_ This step is OS specific, e.g. on Linux it’s `source .venv/bin/activate`.
49
+
_Note:_ This step is OS specific, e.g. on Linux it's `source .venv/bin/activate`.
50
50
51
51
4. Update the Python package installer and other installation packages of your virtual environment.
0 commit comments