arkanum/README.md

78 lines
2.5 KiB
Markdown

<p align="right">
<img src="http://forthebadge.com/images/badges/built-with-love.svg">
<img src="http://forthebadge.com/images/badges/for-you.svg">
</p>
<p align="center">
<a href="https://gitea.ocram85.com/CodeServer/arkanum/">
<img
src="/CodeServer/arkanum/raw/branch/master/assets/social-logo.png"
alt="Container"
>
</a>
</p>
<h1 align="center">
🧙 Arkanum ✨ 🌌 ☄️ 💥
</h1>
<p align="center">
Code-Server container optimized for daily usage ❤
</p>
<p align="center">
<a href="https://ci.ocram85.com/CodeServer/arkanumg">
<img src="https://ci.ocram85.com/api/badges/CodeServer/arkanum/status.svg" alt="Master Branch Build Status">
</a>
</p>
## :book: General
The container is based on the latest `linuxserver/code-server` image.
### 🚀 Starship prompt
The [Starship](starship.rs) 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](./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
- Photo by <a href="https://unsplash.com/@frankiefoto?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText">frank mckenna</a> on <a href="https://unsplash.com/s/photos/container?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText">Unsplash</a>
- A huge thanks to tuanpham for sharing his [code-server font patch](https://github.com/tuanpham-dev/code-server-font-patch).