Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
+ add pyvenv to the repo
  • Loading branch information
Zentropivity committed Sep 27, 2024
1 parent ea83660 commit 9dc437e
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ First you need to make sure the required tools are installed:
- `git` of course

0. Make sure you have the submodules. Either clone this repo with `--recursive` or do `git submodule update --init`
1. Create a python virtual environment and activate it, like: `python -m venv venv` then source right activation file for your shell
2. Run `build_ttf.nu`
1. Create a python virtual environment and activate it, like: `python -m venv venv` then source the activation file for your shell (for nushell just run `./pyvenv`)
2. Run `./build_ttf.nu`
this produces the font file in `out/build/MutantStandard-Regular.ttf`
3. On linux, you could also copy the font and its license to the system fonts by running `sudo install.nu`
3. On linux, you could also copy the font and its license to the system fonts by running `sudo ./install.nu`

## License

Everything in this repository is licensed under a MIT license, except the materials used under the repositories in the folliwing folders have their own licensing:
Everything in this repository is licensed under a MIT license, except the materials used under the repositories in the following folders have their own licensing:

- Mutant Standard emoji in `mutant_standard` are licensed CC BY-NC-SA 4.0 International
- Orxporter in `orxporter` is licensed under the Cooperative Non-Violent License (CNPL) v4
- nanoemoji in `nanoemoji` is licensed under the Apache-2.0 license
- `mutant_standard`: Mutant Standard emoji are licensed CC BY-NC-SA 4.0 International
- `orxporter`: Orxporter is licensed under the Cooperative Non-Violent License (CNPL) v4
- `nanoemoji`: nanoemoji is licensed under the Apache-2.0 license

## Your contributions

Expand Down
15 changes: 15 additions & 0 deletions pyvenv
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/usr/bin/env nu

## activates the python environment in a sub-sub-shell
# defaults to ./venv
# deactivate by exiting
## if command is given after virtual environment location
# after the command ends, the virtualenv exits

def main [path="./venv" ...command] {
if (0 < ($command | length)) {
sh -i -c $"source ($path)/bin/activate ; nu -c ($command | str join ' '); exit 0"
} else {
sh -i -c $"source ($path)/bin/activate ; nu"
}
}

0 comments on commit 9dc437e

Please sign in to comment.