Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antranapp/til
A Swift command-line tool to manage a Today-I-Learned repository.
https://github.com/antranapp/til
argument-parser command-line-tool learning-in-public spm swift swift-package-manager til today-i-learned
Last synced: 3 days ago
JSON representation
A Swift command-line tool to manage a Today-I-Learned repository.
- Host: GitHub
- URL: https://github.com/antranapp/til
- Owner: antranapp
- Created: 2020-04-29T12:28:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-10T14:51:13.000Z (about 4 years ago)
- Last Synced: 2024-12-27T01:22:52.102Z (about 2 months ago)
- Topics: argument-parser, command-line-tool, learning-in-public, spm, swift, swift-package-manager, til, today-i-learned
- Language: Swift
- Homepage:
- Size: 54.7 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Til: Today I Learned
Til is a command line tool written in `Swift` to manage a `Today-I-Learned` repository.
## 😯 What is a Today-I-Leanred (Til) repository?
If you don't know what "Today I Learned" is, then [lmgtfy](https://www.google.com/search?q=today+i+learned)
**A til repository** is a place to store things you have learned or read or stumbled upon.
With a repository, you can go back in time and search for something that you know for sure you have seen before but probably can't find it again, such as in Google.
Using public git repositories to store your tils enable you to share your tils with other peers easily.
This movement has been adopted also by many organisations to provide a bite size information to their audiences, such as:
- [National Geographic TIL](https://video.nationalgeographic.com/video/til)
- [Reddit](https://www.reddit.com/r/todayilearned/)
- ...
## 💻 TIL in software development context
In Software development, we collect over the time so many code snippet, tips, tricks for our jobs. But it is not an easy task to manage such information so that you can easily find them again.
It's also not so easy to share such information with others if you only save them locally on your computers.
I've accidently found[ this discussion in Hacker News](https://news.ycombinator.com/item?id=22908044) about a guy who have been managing [his TIL repository](https://github.com/jbranchaud/til) for over 5 years
His TIL repository is full of interesting and useful information.
Then I take look in github, [the `til` topic](https://github.com/topics/til) is full of interesting repositories.
I'm totally convinced by the idea and also starting to create [a TIL repository for myself](https://github.com/antranapp/today-i-learned):
But after some days, I find it is hard to mange it, and also to find the snippet that I'm looking for again.
So I have started to build a command-line tool to help me managing this TIL respository more easily.
## 😲 I'm sold, so what is this tool?
The command line tool can basically:
- **Add a new topic**: create a markdown file with some pre-filled meta data and open a markdown editor for you to add information
- **Generate a README.md** by aggregating all Tils in the repo and list them in a table view organized by topics.
- **Deploy** all changes to the remote repository.
## 😭 Oh no, why Swift?
Sorry, I'm [iOS developer](https://antran.app).
You should actually try! [Swift](https://swift.org/). It is a relatively easy to learn and powerful programming language.
## 💪 Seriously man, how can I use it?
### Requirements:
- MacOS
- Visual Studio Code (including [the command line](https://code.visualstudio.com/docs/setup/mac))
> I've just tested the tool on my Mac, but theoritically it should also work on Linux (Ubuntu). And soon you should be able to use the tool on [Windows and additinal Linux distributions](https://swift.org/blog/5-3-release-process/).
### Installation:
```
mkdir til
git checkout https://github.com/antranapp/Til.git
cd Til
chmod +x release.sh
./release.sh
```
You can add a `Til.yaml` to customise the settings:
```yaml
root: temp
editor:
name: code
gui: /usr/bin/open -b com.microsoft.VSCode
console: code
```
Available commands:
```swift
Til add
Til generate-readme
Til deploy
```
> I'm working on an easy setup for the tool, such as [using brew](https://medium.com/@mxcl/maintaining-a-homebrew-tap-for-swift-projects-7287ed379324)
### Til Reference
```bash
OVERVIEW: A Swift command-line tool to manage a Today-I-Learned repository
USAGE: Til
OPTIONS:
-h, --help Show help information.
SUBCOMMANDS:
add Add a new Today-I-Learned entry using a default
MarkDown editor.
generate-readme Generate a README.md from the content.
deploy Deploy the content to the remote repository.
```
## 🤯 What is the future plan?
Some ideas I have in mind now:
- A command create a static website so that we can display the tils in Github Pages and also add some Full-Text-Search to that.
- A command to create a PDF from a remote site and attach it to the til to preventing the information going away when the remote sites are not reachable or changed.
- Automatic summarize remote data sources.
If you have any interesting ideas, please tell me what you want to add by creating new issues or new PRs
## 🍻 Resources
There are some similar tools already existed if you want some alternatives:
- An electron app: [https://github.com/seokju-na/geeks-diary](https://github.com/seokju-na/geeks-diary)
- Using Github issues for tils (👌👍): [https://github.com/tieubao/til/issues](https://github.com/tieubao/til/issues)
- A VSCode extension: [https://github.com/rahuldhawani/TILed](https://github.com/rahuldhawani/TILed)
- A Python script: [https://github.com/khanhicetea/today-i-learned](https://github.com/khanhicetea/today-i-learned)
- Tilex - Today I Learned in Elixir: [https://github.com/hashrocket/tilex](https://github.com/hashrocket/tilex)
- Using VuePress: [https://github.com/MarcLoupias/memo-dev](https://github.com/MarcLoupias/memo-dev)