mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-07-21 08:21:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Atlas: some final cleanups (#21947)

Browse Source
This commit is contained in:
Andreas Rumpf
2023-05-28 18:18:30 +02:00
committed by GitHub
parent 5997324709
commit 7ebb042f79
3 changed files with 22 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/atlas.md
View File

@@ -1,7 +1,7 @@
# Atlas Package Cloner
Atlas is a simple package cloner tool that automates some of the
workflows and needs for Nim's stdlib evolution.
Atlas is a simple package cloner tool. It manages an isolated workspace that
contains projects and dependencies.
Atlas is compatible with Nimble in the sense that it supports the Nimble
file format.
@@ -103,7 +103,7 @@ For example:
```
### Clone/Update <url>
### Clone/Update <url>/<package name>
Clones a URL and all of its dependencies (recursively) into the workspace.
Creates or patches a `nim.cfg` file with the required `--path` entries.
@@ -111,12 +111,8 @@ Creates or patches a `nim.cfg` file with the required `--path` entries.
**Note**: Due to the used algorithms an `update` is the same as a `clone`.
### Clone/Update <package name>
The `<package name>` is translated into an URL via `packages.json` and
then `clone <url>` is performed.
**Note**: Due to the used algorithms an `update` is the same as a `clone`.
If a `<package name>` is given instead the name is first translated into an URL
via `packages.json` or via a github search.
### Search <term term2 term3 ...>
@@ -129,10 +125,10 @@ in its description (or name or list of tags).
Use the .nimble file to setup the project's dependencies.
### UpdateWorkspace [filter]
### UpdateProjects / updateDeps [filter]
Update every package in the workspace that has a remote URL that
matches `filter` if a filter is given. The package is only updated
Update every project / dependency in the workspace that has a remote URL that
matches `filter` if a filter is given. The project / dependency is only updated
if there are no uncommitted changes.
### Others

4
doc/tools.md
View File

@@ -42,5 +42,5 @@ The standard distribution ships with the following tools:
so can be useful to run your tests, even the most complex ones.
- | [atlas](atlas.html)
| `atlas`:cmd: is a simple package cloner tool that automates some of the
workflows and needs for Nim's stdlib evolution.
| `atlas`:cmd: is a simple package cloner tool. It manages an isolated workspace that
contains projects and dependencies.