fress is a toolkit for processing information with computers.
-
Code docs: fress.io/fress
-
Repository: github.com/u0xee/fress
This project is named fress (as in "fresh fruit"). It is software (instructions for a computer) that can be used to process information.
Here in this repository (these project files), you will find:
-
Documentation sources in /doc
-
Essay on the trees at /doc/story/forking-trees.adoc (better viewed online forking trees)
-
Images used in documentation in /doc/images
-
-
Source code in /src (code docs viewed online fress.io/fress)
-
The library root at /src/lib.rs
-
The memory module’s root at /src/memory/mod.rs
-
-
Integration tests in /tests
-
Benchmarks in /benches
-
-
Example programs in /examples
You can read the source code and documentation sources, without any special tools.
If you want to run the code, you’ll need to install the Rust programming language.
After you have Rust installed, you can use the cargo program:
-
cargo help -
cargo build -
cargo test -
cargo bench -
cargo run --example basicruns the example program /examples/basic.rs
Documentation sources are turned into the website using Asciidoctor. If you want to build the website yourself, you’ll need to install it, and Python3.
Then you can run the script at /build_docs.py, which runs cargo doc and asciidoctor.
Run the script like this: ./build_docs.py.
Below, and in every source code file, you will find a license notice. Briefly:
-
don’t sue me
-
don’t remove the license notices
-
don’t steal my work (by claiming or implying you did it)
|
Note
|
You can copy, modify, and redistribute this work (build on top of my work), as long as you make it clear that you are building on top of my work. |
Copyright (c) Cole Frederick. All rights reserved. The use and distribution terms for this software are covered by the Eclipse Public License 1.0 (https://opensource.org/licenses/eclipse-1.0.php) which can be found in the file epl-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound by the terms of this license. You must not remove this notice, or any other, from this software.