Skip to content

Commit 9d7994e

Browse files
committed
docs: Create build, channels, contribute documents
1 parent 00d4efb commit 9d7994e

File tree

4 files changed

+36
-18
lines changed

4 files changed

+36
-18
lines changed

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Toltec is a community-maintained repository of free software for [the reMarkable
99

1010
### Install it
1111

12-
Toltec works with the [Opkg](https://code.google.com/archive/p/opkg/) package manager, which is of widespread use in embedded devices.
12+
Toltec works with the [Opkg](https://code.google.com/archive/p/opkg/) package manager, which is in widespread use in embedded devices.
1313
Opkg is not available by default on the reMarkable, but you can install it by following the instructions described in [remarkable\_entware](https://github.com/evidlo/remarkable_entware).
14-
After installing Opkg on your device, add the Toltec repository to `/opt/etc/opkg.conf` and download the repository data:
14+
After installing Opkg on your device, add the Toltec repository to `/opt/etc/opkg.conf` and download the repository data by running the following commands:
1515

1616
```sh
1717
$ cat "src/gz toltec https://toltec.delab.re/stable" >> /opt/etc/opkg.conf
@@ -41,25 +41,20 @@ $ opkg update
4141
$ opkg upgrade
4242
```
4343

44-
### Build it
44+
[See information about advanced Opkg commands →](https://openwrt.org/docs/guide-user/additional-software/opkg)\
45+
[Choose between the _stable_ and _testing_ channels →](docs/channels.md)
4546

46-
This Git repository contains all the necessary tools and recipes to build the packages that are published on the package repository.
47-
The package repository is automatically built and published every time that a commit is pushed to the Git repository, through [Github Actions](https://docs.github.com/en/actions).
48-
Since all the packages on Toltec are free software, you can also **build all of the repository’s packages from source yourself** instead of getting them from the package repository.
49-
The build process is fully [reproducible](https://reproducible-builds.org/), which means you can verify that the published packages have not been tampered with during the automated build process.
47+
### Build it
5048

51-
TODO: Add more information on how to build.
49+
This Git repository contains all the tools and recipes required to build the packages published on the package repository.
50+
This repository is automatically built and published every time that a commit is pushed to Git, using [Github Actions](https://docs.github.com/en/actions).
51+
Since all the packaged software in Toltec is free, you can also **build them from source yourself** instead of using the pre-built binaries.
52+
The build process is fully [reproducible](https://reproducible-builds.org/), which means that you can verify that the published packages have not been tampered with during the automated build process.
5253

53-
<!-- to build all the packages, run `make` from the base repository. this will
54-
involve downloading a docker image (1GB) and the remarkable toolchain which
55-
will expand to 3GB. the final build artifacts will be found in `artifacts/`. -->
54+
[Learn how to build the repository from source →](docs/build.md)
5655

5756
### Improve it
5857

59-
* clone this repository
60-
* switch to `testing` branch
61-
* edit package/$PACKAGE/package, making sure to bump the version
62-
* build the package (`make $PACKAGE`), making sure everything looks ok in artifacts/package/$PACKAGE/
63-
* install the package to your tablet, verifying things work as expected
64-
* for new packages, submit a pull request with the title: [$PACKAGE][$VERSION] - New Package
65-
* for updating packages, submit a pull request with the title: [$PACKAGE][$VERSION] - Updated Package
58+
Your contribution is welcome for adding new packages, updating existing ones or improving the build tooling.
59+
60+
[Learn how to contribute to Toltec →](docs/contribute.md)

docs/build.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Building the repository from source
2+
3+
**TODO**
4+
5+
to build all the packages, run `make` from the base repository. this will
6+
involve downloading a docker image (1GB) and the remarkable toolchain which
7+
will expand to 3GB. the final build artifacts will be found in `artifacts/`.

docs/channels.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Choosing a release channel
2+
3+
**TODO**

docs/contribute.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Contributing to Toltec
2+
3+
**TODO**
4+
5+
### Adding a new package
6+
7+
* clone this repository
8+
* switch to `testing` branch
9+
* edit package/$PACKAGE/package, making sure to bump the version
10+
* build the package (`make $PACKAGE`), making sure everything looks ok in artifacts/package/$PACKAGE/
11+
* install the package to your tablet, verifying things work as expected
12+
* for new packages, submit a pull request with the title: [$PACKAGE][$VERSION] - New Package
13+
* for updating packages, submit a pull request with the title: [$PACKAGE][$VERSION] - Updated Package

0 commit comments

Comments
 (0)