Skip to content

Commit

Permalink
Add license and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mcimam committed Jul 7, 2024
1 parent f7f0be8 commit ad87c8e
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 0 deletions.
9 changes: 9 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@


Copyright 2024 Mcimam

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 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.
67 changes: 67 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@

# Personal Site


This repo contain personal website source code for [mcimam.github.io](https://mcimam.github.io).

Please visit that website, I plan it to be some kind
personal blog for my own note.

Feel free to contact me 🙂

## How to update
1. Make sure hugo is installed on the system
2. Add new content inside [content](/content/)
or use `hugo new content [path] [flags]`
3. Make sure to publish it `draft=true`
4. check using `hugo server`
5. push to branch `main`


## Github Action
This web is deployed on github.io and build using github action.
Full github action things:
```yml
name: github pages

on:
push:
branches:
- main # Set a branch to deploy
pull_request:

jobs:
deploy:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
with:
submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: 'latest'
# extended: true

- name: Build
run: hugo --minify

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public

```


## Techstack
I use following open source project for this web:
- [Hugo](https://github.com/gohugoio/hugo)
- [PaperMod](https://github.com/adityatelange/hugo-PaperMod)

## License
Since i don't think anyone would use this other than me, i don't really mind about license. However, i just put `MIT LICENSE` here.

0 comments on commit ad87c8e

Please sign in to comment.