https://github.com/johnmurray/nim-stuff

A repository for getting started with nim-stuff.
https://github.com/johnmurray/nim-stuff

Last synced: about 2 months ago
JSON representation

A repository for getting started with nim-stuff.

• Host: GitHub
• URL: https://github.com/johnmurray/nim-stuff
• Owner: JohnMurray
• License: agpl-3.0
• Created: 2021-09-21T02:59:38.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-09-29T15:51:35.000Z (over 3 years ago)
• Last Synced: 2024-10-15T23:26:01.771Z (3 months ago)
• Language: Shell
• Size: 32.2 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nim-stuff

[![Passing Tests](https://github.com/JohnMurray/nim-stuff/actions/workflows/test.yaml/badge.svg)](https://github.com/JohnMurray/nim-stuff/actions/workflows/test.yaml)

A basic starter-template for working with Nim in VSCode's container environments. Ships with:

  + Nim `1.4.8`

  + Nimble (latest stable)

  + A basic project configuration

    + Nimble configuration with a basic test task

    + `src/` and `tests/` directory that can be exercised out of the box

  + Basic GitHub workflow for testing

  + Basic standard tooling (gcc, git, curl, zsh, etc)

To be added soon

  + [ ] Add some basic (vscode) tasks for testing/building

  + [ ] Fix test to write binaries to a `build/` dir or something

  + [ ] Mount home directory so configs for zsh/bash/git aren't missing

  + [ ] Nimble publish support

  + [ ] Doc generation (for gh-pages)

To get started:

  + Copy this template & clone it

  + Open with VSCode (inside the dev-container)

  + Run `nimble test` to make sure things are working

  + Enjoy!