title-converter

This is a simple script you can use with Windows, MacOS, and Linux operating systems. The script takes a string of characters and modifies them to match these formatting rules.

Table of Contents

• Tutorial
• Formatting Rules
• Word Replacements
• Suggest Improvements

Tutorial

Before you begin, Windows users should install terminal.

1. Open a terminal window.

2. Type python3 to see if you have python installed. If you don't, simply follow the prompts on your screen.

3. To clone the repository, type the following, then press Enter:

   git clone https://github.com/analog-isaiah/title-converter.git
   

4. In your file explorer, you'll see a folder named title-converter.

5. Copy and paste this folder into your home directory.

   • Windows: this could be C:\Users\yourNameHere>
   • MacOs/Linux: this could be /home/yourNameHere

6. In a terminal window, navigate to your home directory, then type ls to see if you've successfully copied over the title-converter folder.

7. If you're using MacOS or Linux, be sure to give the script executable permissions:

   chmod +rwx ./title-converter/main.py`
   

8. To use the tool, type:

   python3 ./title-converter/main.py
   

9. Convert your title by pasting it into terminal and pressing Enter.

NOTE: In most terminals, you'll need to right-click, middle-click, or Ctrl + Shift + V in order to paste text.

Formatting Rules

Formatting Rule	Example
All lowercase letters	Change this: This Is My TITLE To this: this is my title
No special characters	Change this: this: is my title! To this: this is my title
Replace spaces with dashes	Change this: this is my title To this: this-is-my-title
Replace unique words	Change this: i love c++ To this: i love cpp

Word Replacements

Original	Replacement
A#	asharp
ASP.NET	aspnet
C#	csharp
C++	cpp
F#	fsharp
J#	jsharp
J++	jpp
M#	msharp
ML.NET	mlnet
.NET	dotnet
Q#	qsharp
R++	rpp
X#	xsharp
X++	xpp
xBase++	xbasepp
Z++	zpp

Suggest Improvements

If you find a bug, have a suggestion, or want to add a word to the list of replacements, feel free to create an issue.