fileReader

package module
v2.0.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 29, 2016 License: Apache-2.0 Imports: 9 Imported by: 0

README

fileReader

Golang File Reader will read file and look for commented out delimiters. It will then return a slice of all comments inside delimiters. It will leave the comments and remove the delimiters.

Created By:

Krysler Pinto

Kevin Tucker

Getting Started

  • Install Go
  • Set up go file structure -> go file structure
  • Grab project through go get
File Structure
+-- src
|   +-- github.com
Go Get Repo

This will place the project in you github.com directory.

go get github.com/kwtucker/fileReader

Good Go comment:
// (:This will be read and deleted:)
// (:This will be read
// and deleted:)
Usage
 import (
   "github.com/kwtucker/fileReader"
 )

 func Example() {
   dataSlice := fileReader.ReadFile("~/Desktop/example.go")
   fmt.Println(dataSlice)
 }
Fmt Println Response
[comment, comment2]

To Contribute

Fork Repo and Submit a pull request.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ReadFile

func ReadFile(filename string) []string

ReadFile reades files and writes

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL