diff --git a/drafts/non-tech.md b/drafts/non-tech.md new file mode 100644 index 0000000..b0f949f --- /dev/null +++ b/drafts/non-tech.md @@ -0,0 +1,5 @@ +# Technical Writing For Normal People +## A cheeky thought on technical writing + +Writing is easy, it's just putting creative sounding words on a page isn't it? +And what about _technical writing_, which should be even easier as there's no creativity required!? diff --git a/drafts/readme.md b/drafts/readme.md new file mode 100644 index 0000000..1742239 --- /dev/null +++ b/drafts/readme.md @@ -0,0 +1,6 @@ +# What? + +Sometimes I journal things and I'm not sure really if I actually want to expand on the idea or not. +Effectively this whole directory contains incomplete ideas, scratch and generally part of my personal process for writing. + +Maybe it serves some use to others but really its for my own personal viewing which I leave on this public repository in the hope that someone can find some kind of solace in them. diff --git a/drafts/tech-write.md b/drafts/tech-write.md new file mode 100644 index 0000000..01d79b7 --- /dev/null +++ b/drafts/tech-write.md @@ -0,0 +1,13 @@ +# Technical Writing for the Unemployed + +Unlike most of my other posts which are filled with colloquialisms and a generally casual vernacular this one will not(at least ima try not to). + +## Who this is aimed at + + +Computer Science students: primarily due to the seemingly enormous lack of communicative tact that way too many students seem to reserve. +What I mean is that writing documentation falls unto the typical CS student as being an esoteric, excessive, or otherwise unnecessary task. + +My theory as to why this is follows: most CS students don't get to experience large enough projects where technical documentation is needed. +In conjunction with my theory I propose that large scale projects are exactly what students should be exposed to. +This is in contrast to the current method of using smaller unit sized diff --git a/drafts/work-ethic.md b/drafts/work-ethic.md new file mode 100644 index 0000000..0b6d658 --- /dev/null +++ b/drafts/work-ethic.md @@ -0,0 +1,9 @@ +# A word on work ethic + +Being that I'm close to graduating this semester(only 2 more months yay!) I've started getting more and more questions from other students. +Most are pretty general: _Are you excited/nervous.. what is your plan etc._ +Interestingly enough one of the questions that comes up with jobs, is: _what do I do to stand out_. +Usually I just respond with something to do with whatever project I happen to be working on at that moment, which is nearly always met with: _how do you do that/ how do you find the time/ I'm so busy I can't do anything/ insert time excuse here_. + +I'm not going to say that I'm _t h e b e s t_ at anything but I have put in more time than I can even account for towards the things I want to achieve and it all boils down to one skill. + diff --git a/prebuild/about.md b/prebuild/about.md index b7ec0b8..d88d65b 100644 --- a/prebuild/about.md +++ b/prebuild/about.md @@ -1,23 +1,28 @@ -# About Me -## Hello yes this is me(kinda) +# About Me sorta +## Hello yes ## Who I am -Uhhhhh, yea I'm an infosec student at _literally where University_. -I'm not very fond of academia thus far but I like learning stuff on my own; x86\_64 and ARM are kinda my things right now. -Security is primarily my focus as it gives me a chance to... uhhhhh... I like breaking stuff(software) and seeing what happens. -Making stuff is also lots of fun, especially when done the hard way. +I'm a random on the internet that likes to write software and build stuff. +I also maintain a crusade against jargon and obtuse language; hence why I avoid. -## What/Why this site? huh? +## Why does this even exist tho? -I like journaling things and when it feels like someone could be reading it feels as though I should think about what I say instead of saying ~~spitting truthbombs~~ random things. -Not only that but it gives me a weird motivation to actually do projects outside of school since I think "_oh i should update the site with a new post or something_". -As long as I don't take on a project in a really dumb way I usually try finishing up to where point where it seems somewhat interesting. +I have no idea. +I just know that I like to write about things that might be interesting to me at the time and wanted a somewhat public forum to do it on. +In this way I can force myself to not excuse shit phrasing. + +## So like what do you write about? + +lol... oh wait ur serious.... +Sometimes programming topics, other times I'm doing in gaming and other times something completely random. +I suppose my primary goal however is to write about writing software. + +I tend to stick to Python, Rust, Bash, C, and some web-dev things from time to time. ## Things I enjoy -Not being dead or a fern are probably my top two things I enjoy right ahead of not being a wooly sock in siberia as a third. +ez: Programming, bhop, arena fps games. -Honestly I like making stuff in software, _but hardware is also cool(just exepensive_). -CTF challenges are lots of fun as well, but I've yet to document my findings on one as many have weird rules about sharing, and I feel weird about it as well. +_No particular order btw_ diff --git a/prebuild/build.md b/prebuild/build.md new file mode 100644 index 0000000..c29fbac --- /dev/null +++ b/prebuild/build.md @@ -0,0 +1,103 @@ +# How this site came to be + +## Tech + +The """"tech-stack"""" for this site is [pandoc](https://pandoc.org/) and a single shell script. +Ok, technically there's also the issue about python but really you don't need to use it since the site pages build anyways. + +Yea so here's the shell(bash) script. +I'm going to remove any bashisms soon enough but am very lazy so this is the best I got for ya. +``` +#!/bin/bash +rootDir='./site/' +targetDir='post/' + +post() { + echo Building: $1 + tmp=".swap" + full=".fullswap" + base=`basename $1` + # First build the content of the site + pandoc $1 > $tmp + # Title, images and tables get added/fixed here + sed "s/{TITLE}/${base%.*}<\/title>/g" ./templates/post-header.html > $full + cat $tmp ./templates/post-footer.html >> $full + sed -i 's/<img/<img class="pure-img"/g;s/<table>/<table class="pure-table">/g' $full + + # Move things to proper directory and cleanup + mv $full "$rootDir/$targetDir/${base%.*}.html" + rm -f $tmp +} + +build_all() { + mkdir -p $rootDir/post/ $rootDir/fonts/ $rootDir/img/ + + cp style.css "$rootDir" + cp prebuild/post/style.css "$rootDir/post/" + + cp fonts/* $rootDir/fonts/ + + cp img/ $rootDir/img/ -r + mv $rootDir/img/favicon.png $rootDir/ + + # Try to get xargs to deal with this ugliness + for r in prebuild/*md;do + post $r + done + for p in prebuild/post/*md;do + post $p + done +} + +_help() { + echo 'Options: + -h show this prompt + -p [postDirectory/*] (takes a list of paths to build from) + -r build root pages + -s copy stylesheets + -l run live server' +} +server() { + cd $rootDir + echo 'Address: 0.0.0.0:8080' + python -m SimpleHTTPServer 8080 +} + +if [ -z $1 ] +then + _help + exit 0 +fi + +while getopts ":aslrhp:" opt;do + case "$opt" in + a) + build_all;; + s) + cp style.css "$rootDir" + cp prebuild/post/style.css "$rootDir/$targetDir" + exit 0 + ;; + r) + # Fix targetDir so that it points to the root of the site output + targetDir='' + post './prebuild/about.md' + post './prebuild/links.md' + post './prebuild/index.md' + exit 0 + ;; + p) + for file in ${@:2};do + post $file + done + ;; + h) + _help;; + l) + server;; + esac +done + +``` + +## Story