An open API service indexing awesome lists of open source software.

https://github.com/lumirelle/profiles

Development profiles or something else.
https://github.com/lumirelle/profiles

configs dotconfigs dotfiles manuals preferences profiles resources

Last synced: 8 months ago
JSON representation

Development profiles or something else.

Awesome Lists containing this project

README

          




Profiles

[![Status](https://img.shields.io/badge/status-active-success.svg)](.)
[![GitHub Issues](https://img.shields.io/github/issues/Lumirelle/profiles.svg)](https://github.com/Lumirelle/profiles/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/Lumirelle/profiles.svg)](https://github.com/Lumirelle/profiles/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

---

Development profiles or something else.


## 📝 Table of Content

- [About](#about)
- [Catalogs](#catalogs)
- [Usage](#usage)
- [Manually Setup](#manually_setup)
- [Script Setup](#script_setup)
- [Authors](#authors)

## 🧐 About

Development profiles or something else.

## 📑 Catalogs

The directory structure under `/resources`, is grouped by purpose:

- `/personal`: **<purpose>** Personal usage profiles
- `/work`: **<purpose>** Work-only profiles (Of course, it should be ignored by git)

The directory structure under folders marked as **<purpose>**, is grouped by category:

- `/docs`: Documents, such as manuals
- `/preferences`: **<collection>** Collection of preferences profiles, such as `.gitconfig`
- `/resources`: Resources, such as fonts

The directory structure under folders marked as **<collection>**, is grouped by situation:

- `/deployer`: **<purpose>** Profiles used by deployer
- `/editor`: **<purpose>** Profiles used by editor
- `/formatter`: **<purpose>** Profiles used by formatter
- `/linter`: **<purpose>** Profiles used by linter
- `/package-manager`: **<purpose>** Profiles used by package manager
- `/terminal`: **<purpose>** Profiles used by terminal
- `/vcs`: **<purpose>** Profiles used by version control system
- `/vpn`: **<purpose>** Profiles used by vpn

The directory structure under folders marked as **<purpose>**, is grouped by program. I will not list them all here.

See total catalogs [here](CATALOGS.json).

## 🎈 Usage

### ✋🏼 Manually Setup

Just download the profile you want and put it in the right place.

### 📜 Script Setup

Install this package by node.js package manager like `npm`, `yarn`, `pnpm` and so on.

```shell
pnpm i lumirelle-profiles -g
```

Now, please enjoy! See the help information by using the command below:

```shell
pi --help
```

## ✍️ Authors

- [@Lumirelle](https://github.com/Lumirelle) - Anything