Skip to content

Commit c2f5038

Browse files
committed
Revise Docker description
1 parent 9097cda commit c2f5038

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

README.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@
88

99
No idea what those squiggles are supposed to be? Read the [Introduction](doc/intro.md).
1010

11-
## Online Version: Explore Without Installing Anything
11+
## Online Version
12+
**Explore Without Installing Anything**
1213

1314
The easiest way to have a look at some graph visualizations is to check out the online demo at [https://vgteam.github.io/sequenceTubeMap/](https://vgteam.github.io/sequenceTubeMap/). There you can play with visualizations from a few different data sets as well as look at some examples showcasing different structural features of variation graphs. You can even provide your own [vg](https://github.com/vgteam/vg)-generated data as an input (limited to small file sizes only).
1415

15-
## Local Version: Run the Sequence Tube Map On Your Own
16+
## Local Version
17+
**Run the Sequence Tube Map on Your Own**
1618

1719
If you are using vg and want visualize the graphs it generates, the online version is limited to small file sizes. For visualizing bigger data sets you can run the Sequence Tube Map on your own. You can either run the Tube Map completely on your local machine or use your local browser to access a Tube Map server running on any other machine you have access to.
1820

19-
(Previously we provided a docker image at [https://hub.docker.com/r/wolfib/sequencetubemap/](https://hub.docker.com/r/wolfib/sequencetubemap/), which contained the build of this repo as well as a vg executable for data preprocessing and extraction. We now recommend a different installation approach.)
20-
2121
### Prerequisites
2222

2323
* The NodeJS version [specified in the `.nvmrc` file](https://github.com/vgteam/sequenceTubeMap/blob/master/.nvmrc), which as of this writing is **18.7.0**. Other several other NodeJS versions will work, or at least mostly work, but only this version is tested. This version of NodeJS can be installed on most systems with [nvm](https://github.com/nvm-sh/nvm).
@@ -71,11 +71,15 @@ To set up a custom visualization of particular files, you will need to configure
7171

7272
### Adding your Own Data
7373

74-
To load your own data into the Sequence Tube Map, see the guide to [Adding your Own Data](doc/data.md).
74+
To load your own data into the Sequence Tube Map, see the guide to [Adding Your Own Data](doc/data.md).
75+
76+
## Docker
77+
78+
Previously we provided a Docker image at [https://hub.docker.com/r/wolfib/sequencetubemap/](https://hub.docker.com/r/wolfib/sequencetubemap/), which contained the build of this repo as well as a vg executable for data preprocessing and extraction. We now recommend a different installation approach, either using the [online version](#online-version) or a full installation of the [local version](#local-version). However, if you would like to Dockerize the Sequence Tube Map, the repository includes a `Dockerfile`.
7579

7680
## Contributing
7781

78-
For information on how to develop on the Sequence Tube Map codebase, pleas see [the Development Guide](doc/development.md).
82+
For information on how to develop on the Sequence Tube Map codebase, pleas see the [Development Guide](doc/development.md).
7983

8084
## License
8185

doc/development.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ If you want to run all the tests, you can run:
3838
npm run test -- --watchAll=false
3939
```
4040

41-
You can also set the environment variable `CI=true`, or [look sufficiently like a kind of CI environment known to `reach-scripts`](https://create-react-app.dev/docs/running-tests/#command-line-interface).
41+
You can also set the environment variable `CI=true`, or [look sufficiently like a kind of CI environment known to `react-scripts`](https://create-react-app.dev/docs/running-tests/#command-line-interface).
4242

4343
If you want to run just a single test, based on its `describe` or `it` name argument, you can do something like:
4444

0 commit comments

Comments
 (0)