Ghost in Shell

Setup code for Shell on Linux.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Shell environment setup.

(back to top)

Built With

• Zsh
  • Oh-My-Zsh
• Neovim
  • LunarVim
• Tmux
• Alacritty
• Tools
  • Linuxbrew
  • z navigation
  • powerline10k
  • fzf

(back to top)

Getting Started

The following shows how to use this shell setup.

Prerequisites

• The repo only works on Linux (Ubuntu/Debian and Arch)
• Root access is required (TODO: how to circumvent this)

Installation

1. As root user download this repo somewhere - e.g. /tmp

   root$ git clone https://github.com/Oceanbao/dots.git

2. Create new user (or existing user) and install basic libs

   root$ ./dots/install.sh init
   # Follow the instruction to create/use `USER`

3. Install Linuxbrew via USER shell (this is required by Linuxbrew)

   USER$ git clone https://github.com/Oceanbao/dots.git
   USER$ ./dots/install.sh brew

4. As root install all dotfiles

   root$ ./dots/install.sh dotup

5. As USER install post-setups

   # neovim
   USER$ ./dots/install.sh vim

6. Setup for zsh theme and neovim

   # Go to USER shell
   root$ su - $USER
   # This will prompt powerline13k setup
   # Then setup vim by enter vim
   
   # LunarVim
   vim
   # run :PackerSync

(back to top)

Usage

Once the Installation is successful, USER shell will have:

• Neovim with Completion

• Neovim with Telescope

(back to top)

Roadmap

• Streamline installation without root access
• Streamline installation by single step
• Support more platforms

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

TODO:

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ocean Bao - @oceanbao - [email protected]

(back to top)

Acknowledgments

• Inspired by craftzdog's dotfiles

(back to top)