Skip to content

Commit

Permalink
docs: Create build, channels, contribute documents
Browse files Browse the repository at this point in the history
  • Loading branch information
matteodelabre committed Sep 10, 2020
1 parent 00d4efb commit 9d7994e
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 18 deletions.
31 changes: 13 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Toltec is a community-maintained repository of free software for [the reMarkable

### Install it

Toltec works with the [Opkg](https://code.google.com/archive/p/opkg/) package manager, which is of widespread use in embedded devices.
Toltec works with the [Opkg](https://code.google.com/archive/p/opkg/) package manager, which is in widespread use in embedded devices.
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).
After installing Opkg on your device, add the Toltec repository to `/opt/etc/opkg.conf` and download the repository data:
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:

```sh
$ cat "src/gz toltec https://toltec.delab.re/stable" >> /opt/etc/opkg.conf
Expand Down Expand Up @@ -41,25 +41,20 @@ $ opkg update
$ opkg upgrade
```

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

This Git repository contains all the necessary tools and recipes to build the packages that are published on the package repository.
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).
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.
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.
### Build it

TODO: Add more information on how to build.
This Git repository contains all the tools and recipes required to build the packages published on the package repository.
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).
Since all the packaged software in Toltec is free, you can also **build them from source yourself** instead of using the pre-built binaries.
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.

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

### Improve it

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

[Learn how to contribute to Toltec →](docs/contribute.md)
7 changes: 7 additions & 0 deletions docs/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Building the repository from source

**TODO**

to build all the packages, run `make` from the base repository. this will
involve downloading a docker image (1GB) and the remarkable toolchain which
will expand to 3GB. the final build artifacts will be found in `artifacts/`.
3 changes: 3 additions & 0 deletions docs/channels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Choosing a release channel

**TODO**
13 changes: 13 additions & 0 deletions docs/contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Contributing to Toltec

**TODO**

### Adding a new package

* clone this repository
* switch to `testing` branch
* edit package/$PACKAGE/package, making sure to bump the version
* build the package (`make $PACKAGE`), making sure everything looks ok in artifacts/package/$PACKAGE/
* install the package to your tablet, verifying things work as expected
* for new packages, submit a pull request with the title: [$PACKAGE][$VERSION] - New Package
* for updating packages, submit a pull request with the title: [$PACKAGE][$VERSION] - Updated Package

0 comments on commit 9d7994e

Please sign in to comment.