arkanum/README.md
OCram85 4b704e4dd0
All checks were successful
ci/woodpecker/push/renovate Pipeline was successful
ci/woodpecker/push/test Pipeline was successful
ci/woodpecker/push/next Pipeline was successful
ci/woodpecker/push/deploy Pipeline was successful
adds AGPLv3 license (#20)
#### 📖 Summary

- adds license
- adds credits for existing project which Arkanum is based on.

#### 📑 Test Plan

> 💡 Select your test plan for the code changes.

- [x] CI pipeline tests
- [ ] Custom test
- [ ] No test plan

##### Details / Justification

<!-- Add your test details or justification for missing tests here. -->

#### 📚 Additional Notes

<!-- A place for additional detail notes. -->

Co-authored-by: OCram85 <marco.blessing@googlemail.com>
Reviewed-on: CodeServer/arkanum#20
2022-11-21 20:00:59 +01:00

3.4 KiB

Container

🧙 Arkanum 🌌 ☄️ 💥

Code-Server container optimized for daily use. ❤

Master Branch Build Status

📖 General

The container is based on the latest linuxserver/code-server image.

🚀 Starship prompt

The Starship prompt is added an enabled as default. Default config uses Emojis and FiraCode icons.

🔱 git config

Adds default system config with:

  • enabled plain credential store for remote.
  • enabled bash completion for git command.
  • added git log helper lg1 + lg2

💡 See gitconfig-system for details.

🧙 Added arkanum helper script

Added arkanum to help installing common runtime in container. This helps reducing the image size.

🧙 arkanum ✨🌌☄️💥 is used to install optional runtimes for developing in a
  code-server container environment.

  Syntax: arkanum RUNTIME ...
  RUNTIME         [dotnet|golang|nodejs|powershell]
    dotnet        Installs latest LTS dotnet core sdk + runtime.
    gitea         Installs gitea tools like the changelog generator.
    golang        Installs golang 1.19.3.
    nodejs        Installs latest NodeJs LTS version.
    powershell    Installs latest PowerShell LTS version.
  --disable-motd     Disables hint in new bash terminal.
  --reset-codesetting    Sets VS Code user setting with basic (Fira Code).
  -h              Prints this help message.

  Example 1: arkanum dotnet
  Example 2: arkanum golang nodejs
  Example 3: arkanum --disable-motd

💳 Credits

Akranum is based on the following projects and wouldn't be possible without:

⚖️ License (AGPLv3)

AGPL

Arkanum - Code-Server container optimized for daily use. Copyright (C) 2022 "OCram85 me@ocram85.com"

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.