Skip to content

Commit 920793e

Browse files
authored
readme/todo cleanup (#1322)
* remove outdated todo list * clean up outdated info from README
1 parent 30e7014 commit 920793e

File tree

2 files changed

+6
-56
lines changed

2 files changed

+6
-56
lines changed

readme.markdown

Lines changed: 6 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,30 @@
11
# Nimble
22

3-
4-
Nimble is the default *package manager* for the
5-
[Nim programming language](https://nim-lang.org).
6-
7-
8-
3+
Nimble is the default *package manager* for the [Nim programming language](https://nim-lang.org).
94

105
## Documentation
116

12-
Interested in how to use Nimble? See the
13-
[Nimble Guide](https://nim-lang.github.io/nimble/index.html),
7+
Interested in how to use Nimble? See the [Nimble Guide](https://nim-lang.github.io/nimble/index.html),
148
where you can learn:
159
- [How to install existing packages](https://nim-lang.github.io/nimble/use-packages.html)
1610
- [How to create a Nimble package](https://nim-lang.github.io/nimble/create-packages.html)
1711
- [How to use `nimble develop` workflow](https://nim-lang.github.io/nimble/workflow.html)
1812

19-
2013
This documentation is for the latest commit of Nimble.
2114
Nim releases ship with a specific version of Nimble and may
2215
not contain all the features and fixes described here.
2316
`nimble -v` will display the version of Nimble in use.
2417

25-
The Nimble changelog can be found
26-
[here](https://github.com/nim-lang/nimble/blob/master/changelog.markdown).
27-
28-
29-
30-
31-
32-
## Repository information
33-
34-
This repository has two main branches: `master` and `stable`.
35-
36-
The `master` branch is...
37-
38-
* default
39-
* bleeding edge
40-
* tested to compile with a pinned (close to HEAD) commit of Nim
41-
42-
The `stable` branch is...
43-
44-
* installed by `koch tools`/`koch nimble`
45-
* relatively stable
46-
* should compile with Nim HEAD as well as the latest Nim version
47-
48-
Note: The travis build only tests whether Nimble works with the latest Nim
49-
version.
50-
51-
A new Nim release (via `koch xz`) will always bundle the `stable` branch.
52-
53-
54-
55-
18+
The Nimble changelog can be found [here](https://github.com/nim-lang/nimble/blob/master/changelog.markdown).
5619

5720
## Contribution
5821

59-
If you would like to help, feel free to fork and make any additions you see fit
60-
and then send a pull request.
61-
62-
If you have any questions about the project, you can ask me directly on GitHub,
63-
ask on the Nim [forum](https://forum.nim-lang.org), or ask on Freenode in
64-
the #nim channel.
65-
66-
67-
68-
22+
If you would like to help, feel free to fork and make any additions you see fit and then send a pull request.
23+
If you have questions about the project, you can ask directly on GitHub or reach out to the [Nim community](https://github.com/nim-lang/Nim?tab=readme-ov-file#community).
6924

7025
## About
7126

7227
Nimble has been written by [Dominik Picheta](https://picheta.me/) with help from
73-
a number of
74-
[contributors](https://github.com/nim-lang/nimble/graphs/contributors).
28+
a number of [contributors](https://github.com/nim-lang/nimble/graphs/contributors).
7529
It is licensed under the 3-clause BSD license, see [license.txt](license.txt)
7630
for more information.

todo.markdown

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)