From df800a1e04b82c0ac679c3374fe59757e7acb486 Mon Sep 17 00:00:00 2001 From: yuk7 Date: Sat, 16 Mar 2019 14:52:22 +0900 Subject: [PATCH] Create README.md [ci skip] --- README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..41df958 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +# CentWSL +CentOS on WSL (Windows 10 FCU or later) +based on [wsldl](https://github.com/yuk7/wsldl) + +[![Build Status](https://img.shields.io/travis/yuk7/CentWSL.svg?style=flat-square)](https://travis-ci.org/yuk7/CentWSL) +[![Github All Releases](https://img.shields.io/github/downloads/yuk7/CentWSL/total.svg?style=flat-square)](https://github.com/yuk7/CentWSL/releases/latest) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) +![License](https://img.shields.io/github/license/yuk7/CentWSL.svg?style=flat-square) + +### [Download](https://github.com/yuk7/CentWSL/releases/latest) + + +## Requirements +* Windows 10 Fall Creators Update x64 or later. +* Windows Subsystem for Linux feature is enabled. + +## Install +#### 1. [Download](https://github.com/yuk7/CentWSL/releases/latest) installer zip + +#### 2. Extract all files in zip file to same directory + +#### 3.Run CentOS.exe to Extract rootfs and Register to WSL +Exe filename is using to the instance name to register. +If you rename it you can register with a diffrent name and have multiple installs. + + +## How-to-Use(for Installed Instance) +#### exe Usage +```dos +Usage : + + - Open a new shell with your default settings. + + run + - Run the given command line in that distro. Inherit current directory. + + config [setting [value]] + - `--default-user `: Set the default user for this distro to + - `--default-uid `: Set the default user uid for this distro to + - `--append-path `: Switch of Append Windows PATH to $PATH + - `--mount-drive `: Switch of Mount drives + + get [setting] + - `--default-uid`: Get the default user uid in this distro + - `--append-path`: Get on/off status of Append Windows PATH to $PATH + - `--mount-drive`: Get on/off status of Mount drives + - `--lxuid`: Get LxUID key for this distro + + backup + - Output backup.tar.gz to the current directory using tar command. + + clean + - Uninstall the distro. + + help + - Print this usage message. +``` + + +#### How to uninstall instance +```dos +>CentOS.exe clean + +```