Skip to content

Commit

Permalink
change readme
Browse files Browse the repository at this point in the history
  • Loading branch information
orzklv committed Aug 14, 2024
1 parent 87abe0f commit bb646d6
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 49 deletions.
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Sokhibjon Orzikulov
Copyright (c) 2023 Kolyma's Laboratory

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
63 changes: 16 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,42 @@
<p align="center">
<img src=".github/assets/header.png" alt="Orzklv's {Nix}">
<img src=".github/assets/header.png" alt="Kolyma's {Instances}">
</p>

<p align="center">
<h3 align="center">My nix configurations for all my NixOS & Apple machines.</h3>
<h3 align="center">Kolyma's Nix configurations for all server instances.</h3>
</p>

<p align="center">
<img align="center" src="https://img.shields.io/github/languages/top/orzklv/nix?style=flat&logo=nixos&logoColor=ffffff&labelColor=242424&color=242424" alt="Top Used Language">
<a href="https://t.me/orzklvb"><img align="center" src="https://img.shields.io/badge/Chat-grey?style=flat&logo=telegram&logoColor=ffffff&labelColor=242424&color=242424" alt="Telegram Channel"></a>
<a href="https://github.com/orzklv/nix/actions/workflows/test.yml"><img align="center" src="https://img.shields.io/github/actions/workflow/status/orzklv/nix/test.yml?style=flat&logo=github&logoColor=ffffff&labelColor=242424&color=242424" alt="Test CI"></a>
<img align="center" src="https://img.shields.io/github/languages/top/kolyma-labs/instances?style=flat&logo=nixos&logoColor=ffffff&labelColor=242424&color=242424" alt="Top Used Language">
<a href="https://github.com/kolyma-labs/instances/actions/workflows/test.yml"><img align="center" src="https://img.shields.io/github/actions/workflow/status/kolyma-labs/instances/test.yml?style=flat&logo=github&logoColor=ffffff&labelColor=242424&color=242424" alt="Test CI"></a>
</p>

## About

In this repository I keep all my configurations and dot files to maintain my healthy development environment for any case. It contains configurations
for shell and environments for any linux distro and macos. It comes with installer to shorten my time spending on set up.
This repository is intended to keep all configurations of global servers ran by Kolyma's Laboratory. Configurations contain both service and
environmental implications.

> Everytime I installed my dev env manually by myself, I started feeling like a garbage myself... So here you are!
> Maybe it's time to start embracing declarative & reproducible server configs?!
## Features

- Syntax Highlighting
- Auto Completions
- Auto Suggestions
- Services & Containers
- Rust made replacements
- Key configurations
- Software configurations
- Selfmade scripts

## Install Nix
## Get NixOS Ready on your server

Before installing my configuration, we need to get nix ready in our machine. We could have used official installer, but due to many reasons, I prefer going with installer by [determinate.systems](https://determinate.systems/oss/).
This is actually quite hard task as it requires a few prequisites to be prepared beforehand. You may refer to [bootstrap](https://github.com/kolyma-labs/bootstrap) and [installer](https://github.com/kolyma-labs/instances) for further instructions.

```shell
curl --proto '=https' --tlsv1.2 -sSf -L \
https://install.determinate.systems/nix | sh -s -- install
```

## Install my configurations

### Home Manager configs

I do have many configurations written on my nix flake, however, for my macs, it actually detects automatically. However, for Linux machines, it's necessary to show which build to use:

```shell
# Apple Macs
nix run github:nix-community/home-maagner -- switch --flake github:orzklv/nix#sakhib@apple
## Installing configurations

# Intel Apple Macs
nix run github:nix-community/home-maagner -- switch --flake github:orzklv/nix#sakhib@old-apple

# Non NixOS Linux
nix run github:nix-community/home-maagner -- switch --flake github:orzklv/nix#sakhib@unstable

# Stable Latest NixOS
nix run github:nix-community/home-maagner -- switch --flake github:orzklv/nix#sakhib@stable
```

### NixOS & Home Manager configs

I've written ready configurations for my machines that are using NixOS, so here you are:
After you get NixOS running on your machine, the next step is to apply declarative configurations onto your machines:

```shell
# Station (Home Gaming)
sudo nixos-rebuild switch --flake github:orzklv/nix#Guts --upgrade

# Experimental (Work PC)
sudo nixos-rebuild switch --flake github:orzklv/nix#Experimental --upgrade
# Kolyma Station {1,2,3}
sudo nixos-rebuild switch --flake github:kolyma-labs/instances#Kolyma-X --upgrade
```

## Thanks
Expand All @@ -82,5 +51,5 @@ sudo nixos-rebuild switch --flake github:orzklv/nix#Experimental --upgrade
This project is licensed under the MIT License - see the [LICENSE](license) file for details.

<p align="center">
<img src=".github/assets/footer.png" alt="Orzklv's {Nix}">
</p>
<img src=".github/assets/footer.png" alt="Kolyma's {Instances}">
</p>

0 comments on commit bb646d6

Please sign in to comment.